System: Archive Data

Archive Data (ARCHIVE via script) is a system-level command that triggers the service to archive data older than a specified retention period from your FMS database (whether internal or SQL). Once the data is archived, it is stored in a designated directory location that can be accessed via FMS reports, for viewing of the data and/or for sharing the data with downstream business users. See Running CygNet Measurement Reports for more information about that process.

You must have proper security authorization to execute this command. See FMS Security (and CMDSYS security event) for information about configuring security access for FMS commands.

See Archiving CygNet Measurement Data for more information about the archiving process.

See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands.

See CxFms for more information about scripting commands.

Data Archiving Considerations

Prior to performing a data archiving task, consider the overall impact on your system resources, and the status of the various data records associated with your measurement devices.

Because archived data is read-only, do not archive data until you are confident that all data within the time range to be archived (older than the retention period) is in an optimal state that will provide the "best possible data" for downstream usage.

See Archiving CygNet Measurement Data for more information.

Configuring Data Archiving Keywords to Enable Archiving

Prior to running Archive Data commands, the data retention period and archive file path must be specified. Archiving Keywords are configured and enabled by users with proper security access, via the FMS configuration file (fms.cfg) by users with proper security access.

Two keywords located in the Archiving Keywords section of the FMS configuration file set the constraints for the Archive Data command.

• Data Retention Period - Configure the database maintenance retention period beyond which data will be archived when the command is run, by specifying a value for the DATA_RETENTION archiving keyword.

• Archive File Path - Configure the directory file path to which the archived data files will be sent, by specifying a value for the ARCHIVE_PATH archiving keyword.

See Service Configuration Files and FMS Configuration File Keywords for more information about CygNet Measurement (FMS) service configuration files.

To Set Up FMS Data Archiving

1. On your host server, open the FMS configuration file (CygNet\Services\FMS\fms.cfg).
2. In the Archiving Keywords section, make the following modifications.

1. Remove the pound sign (#) to uncomment the DATA_RETENTION keyword line, and set the keyword value to the minimum time period, in number of days, for which you will always retain data in your FMS database.
2. Remove the pound sign (#) to uncomment the ARCHIVE_PATH keyword line, and set the keyword value to the file directory path where you will store archived FMS files.

1. Save the settings and close the file.
2. Start or Restart the FMS.

Configuring an Archive Data Command

The Archive Data command is run against the FMS service, rather than against specific Nodes, and can only be executed via the Master Scheduling Service (MSS) in CygNet Explorer, or via scripting.

Command Definition Properties

The following command definition properties apply to Archive Data commands, when scheduling, creating, or editing commands via CygNet Explorer (MSS). See Scheduling FMS Command Tasks in the MSS for more information.

Property	Description
FMS service	Select a Site.Service for the command from the available FMS service list in the drop-down menu.
Command	Select the desired Command name from the drop-down menu. See FMS Commands for more information about available command types.
Priority	Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows. Low level Medium level High level User initiated transaction Admin initiated transaction Default value is Low level processing queue priority.
Logging	Select a Logging level for the command results from the drop-down menu. Options are as follows. Low - displays errors Medium - displays errors and warnings High - displays errors, warnings, and additional information applicable to the command Default value is Low level logging when scheduling a command in the MSS.

Command Parameters

No command parameters appear in the dialog box for this command. Data retention and file location information that applies to Archive Data commands is configured via the FMS configuration file (fms.cfg), by users with proper security access.